Connection groups
You can obtain all the details you need for the data warehouse connection groups in a specified catalog.
Request
The user account used for making this request should have the Manage Data Warehouses permission; for example, organization administrator or super user. For details, see Managing Users with the Identity Broker.
A query for connection groups must include the following:
- The SELECT statement must start with one or more connection group parameters (comma separated).
- After the parameters you must provide the following data source:
FROM $system.DBSCHEMA_CONNECTION_GROUPS
You can request the following connection group parameters:
- AGGREGATE_SCHEMA
- CONNECTION_ID
- DATABASE
- FILESYSTEM_TYPE
- FILESYSTEM_URI
- ID
- IS_CANARY_ALWAYS_ENABLED
- IS_IMPERSONATION_ENABLED
- IS_PARTIAL_AGG_HIT_ENABLED
- NAME
- ORGANIZATION_ID
- PLATFORM_TYPE
- READ_ONLY
For details about the parameter types, see the xsd:schema
element in
the sample response provided below.
Response
The response contains a <row>
element for each connection group in the
specified catalog. Each of these elements contains the values of the
requested parameters.
Sample request
The example here shows how to make a request with the curl
tool:
- The requested data are the connection ID (CONNECTION_ID), name of the connection group (NAME), platform type (PLATFORM_TYPE), and whether it is read-only (READ_ONLY).
- The request is for the connection groups in the Sales Insights catalog.
- The token is obtained in advance.
- The query is for the default organization.
- The address of the AtScale system is:
http://example.com:10502/xmla/default
The XML part of the request is as follows:
<?xml version="1.0"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body>
<Execute xmlns="urn:schemas-microsoft-com:xml-analysis">
<Command>
<Statement>SELECT CONNECTION_ID, NAME, PLATFORM_TYPE, READ_ONLY FROM $system.DBSCHEMA_CONNECTION_GROUPS</Statement>
</Command>
<Properties>
<PropertyList>
<Catalog>Sales Insights</Catalog>
</PropertyList>
</Properties>
</Execute>
</Body>
</Envelope>
Here is the full form of the curl request:
curl -X POST \
-H "Authorization:Bearer $token" -H 'Content-Type: application/xml' \
-d '<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">\
<Body><Execute xmlns="urn:schemas-microsoft-com:xml-analysis">\
<Command>\
<Statement>SELECT CONNECTION_ID, NAME, PLATFORM_TYPE, READ_ONLY FROM $system.DBSCHEMA_CONNECTION_GROUPS</Statement>\
</Command>\
<Properties><PropertyList>\
<Catalog>Sales Insights</Catalog>
</PropertyList></Properties>\
</Execute></Body></Envelope>' \
http://example.com:10502/xmla/default
Sample response
The response for the sample request above contains <row>
elements for
each connection group found. As requested, each of these elements
contains only the connection ID, the name of the connection group, the
platform type, and whether it is read-only:
<row>
<CONNECTION_ID>Connection1</CONNECTION_ID>
<NAME>MSSQL Data Warehouse</NAME>
<PLATFORM_TYPE>mssql</PLATFORM_TYPE>
<READ_ONLY>false</READ_ONLY>
</row>
Here is the full response:
<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<as:queryId xmlns:as="http://xsd.atscale.com/soap_v1" soap:mustUnderstand="0">e22362cf-c15e-42ff-8b83-8cd9991a9bbb</as:queryId>
</soap:Header>
<soap:Body>
<ExecuteResponse xmlns="urn:schemas-microsoft-com:xml-analysis">
<return>
<root xmlns="urn:schemas-microsoft-com:xml-analysis:rowset" xmlns:msxmla="http://schemas.microsoft.com/analysisservices/2003/xmla" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<xsd:schema xmlns:sql="urn:schemas-microsoft-com:xml-sql" targetNamespace="urn:schemas-microsoft-com:xml-analysis:rowset" elementFormDefault="qualified">
<xsd:element name="root">
<xsd:complexType>
<xsd:sequence minOccurs="0" maxOccurs="unbounded">
<xsd:element name="row" type="row"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:simpleType name="uuid">
<xsd:restriction base="xsd:string">
<xsd:pattern value="[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{12}"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="xmlDocument">
<xsd:sequence>
<xsd:any/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="row">
<xsd:sequence>
<xsd:element sql:field="CONNECTION_ID" name="CONNECTION_ID" type="xsd:string" minOccurs="0"/>
<xsd:element sql:field="NAME" name="NAME" type="xsd:string" minOccurs="0"/>
<xsd:element sql:field="PLATFORM_TYPE" name="PLATFORM_TYPE" type="xsd:string" minOccurs="0"/>
<xsd:element sql:field="READ_ONLY" name="READ_ONLY" type="xsd:boolean" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
<row>
<CONNECTION_ID>con1</CONNECTION_ID>
<NAME>MSSQL Data Warehouse</NAME>
<PLATFORM_TYPE>mssql</PLATFORM_TYPE>
<READ_ONLY>false</READ_ONLY>
</row>
</root>
</return>
</ExecuteResponse>
</soap:Body>
</soap:Envelope>
More information
- Request reference: How to make requests to the Data Catalog API.
- Response reference: How to receive and process responses from the Data Catalog API.